home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / Xm / XmConvertStringToUnits.z / XmConvertStringToUnits
Encoding:
Text File  |  2001-04-17  |  7.8 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttSSSSttttrrrriiiinnnnggggTTTTooooUUUUnnnniiiittttssss((((3333XXXX))))UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVVXXXXmmmmCCCCoooonnnnvvvveeeerrrrttttSSSSttttrrrriiiinnnnggggTTTTooooUUUUnnnniiiittttssss((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttSSSSttttrrrriiiinnnnggggTTTTooooUUUUnnnniiiittttssss - A function that converts a string
  10.           specification to a unit value
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/Xm.h>
  14.           iiiinnnntttt XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttSSSSttttrrrriiiinnnnggggTTTTooooUUUUnnnniiiittttssss(
  15.           SSSSccccrrrreeeeeeeennnn ****ssssccccrrrreeeeeeeennnn,
  16.           SSSSttttrrrriiiinnnngggg ssssppppeeeecccc,
  17.           iiiinnnntttt oooorrrriiiieeeennnnttttaaaattttiiiioooonnnn,
  18.           iiiinnnntttt ttttoooo____ttttyyyyppppeeee,
  19.           XXXXttttEEEEnnnnuuuummmm ****ppppaaaarrrrsssseeee____eeeerrrrrrrroooorrrr);
  20.  
  21.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  22.           This page documents Motif 2.1.
  23.  
  24.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  25.           XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttSSSSttttrrrriiiinnnnggggTTTTooooUUUUnnnniiiittttssss converts a string specification value
  26.           and returns the converted value as the return value from the
  27.           function.  This function uses the specified screen's
  28.           resolution to compute the number of units for the string
  29.           specification.
  30.  
  31.           _s_c_r_e_e_n    Specifies the screen whose resolution is to be
  32.                     used for the computation.
  33.  
  34.           _s_p_e_c      Specifies the string, in <_f_l_o_a_t_i_n_g _v_a_l_u_e><_u_n_i_t>
  35.                     format, to be converted.
  36.  
  37.           _o_r_i_e_n_t_a_t_i_o_n
  38.                     Specifies whether the converter uses the
  39.                     horizontal or vertical screen resolution when
  40.                     performing the conversion. The
  41.                     _o_r_i_e_n_t_a_t_i_o_nparameter can have values of
  42.                     XXXXmmmmHHHHOOOORRRRIIIIZZZZOOOONNNNTTTTAAAALLLL or XXXXmmmmVVVVEEEERRRRTTTTIIIICCCCAAAALLLL.
  43.  
  44.           _t_o__t_y_p_e   Converts the value to the unit type specified.
  45.                     Refer to the XXXXmmmmNNNNuuuunnnniiiittttTTTTyyyyppppeeee resource of the XXXXmmmmGGGGaaaaddddggggeeeetttt,
  46.                     XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr, or XXXXmmmmPPPPrrrriiiimmmmiiiittttiiiivvvveeee reference page.  This
  47.                     parameter can have one of the following values:
  48.  
  49.                     XXXXmmmmPPPPIIIIXXXXEEEELLLLSSSS  The returned value will be the number of
  50.                               pixels.
  51.  
  52.                     XXXXmmmmMMMMIIIILLLLLLLLIIIIMMMMEEEETTTTEEEERRRRSSSS
  53.                               The returned value will be the number of
  54.                               millimeters.
  55.  
  56.                     _X_m_1_0_0_T_H__M_I_L_L_I_M_E_T_E_R_S
  57.                               The returned values will be the number
  58.                               of 1/100 millimeters.
  59.  
  60.  
  61.  
  62.  
  63.      Page 1                                           (printed 4/6/01)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttSSSSttttrrrriiiinnnnggggTTTTooooUUUUnnnniiiittttssss((((3333XXXX))))UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVVXXXXmmmmCCCCoooonnnnvvvveeeerrrrttttSSSSttttrrrriiiinnnnggggTTTTooooUUUUnnnniiiittttssss((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     XXXXmmmmCCCCEEEENNNNTTTTIIIIMMMMEEEETTTTEEEERRRRSSSS
  75.                               The returned values will be the number
  76.                               of centimeters.
  77.  
  78.                     XXXXmmmmIIIINNNNCCCCHHHHEEEESSSS  The returned values will be the number
  79.                               of inches.
  80.  
  81.                     _X_m_1_0_0_0_T_H__I_N_C_H_E_S
  82.                               The returned values will be the number
  83.                               of 1/100 inches.
  84.  
  85.                     XXXXmmmmPPPPOOOOIIIINNNNTTTTSSSS  The returned values will be the number
  86.                               of points.  A point is a text processing
  87.                               unit defined as 1/72 of an inch.
  88.  
  89.                     _X_m_1_0_0_T_H__P_O_I_N_T_S
  90.                               The returned values will be the number
  91.                               of 1/100 points.
  92.  
  93.                     XXXXmmmmFFFFOOOONNNNTTTT____UUUUNNNNIIIITTTTSSSS
  94.                               All values provided to the widget are
  95.                               treated as font units. A font unit has
  96.                               horizontal and vertical components.
  97.                               These are the values of the XmScreen
  98.                               resources XXXXmmmmNNNNhhhhoooorrrriiiizzzzoooonnnnttttaaaallllFFFFoooonnnnttttUUUUnnnniiiittttand
  99.                               XXXXmmmmNNNNvvvveeeerrrrttttiiiiccccaaaallllFFFFoooonnnnttttUUUUnnnniiiitttt.
  100.  
  101.                     _X_m_1_0_0_T_H__F_O_N_T__U_N_I_T_S
  102.                               All values provided to the widget are
  103.                               treated as 1/100 of a font unit.  A font
  104.                               unit has horizontal and vertical
  105.                               components.  These are the values of the
  106.                               XmScreen resources
  107.                               XXXXmmmmNNNNhhhhoooorrrriiiizzzzoooonnnnttttaaaallllFFFFoooonnnnttttUUUUnnnniiiittttand
  108.                               XXXXmmmmNNNNvvvveeeerrrrttttiiiiccccaaaallllFFFFoooonnnnttttUUUUnnnniiiitttt.
  109.  
  110.           _p_a_r_s_e__e_r_r_o_r
  111.                     Specifies if a parsing error occurred. This is set
  112.                     to a value of True indicates that an error
  113.                     occurred, a value of False to indicate no error.
  114.  
  115.      RRRREEEETTTTUUUURRRRNNNN
  116.           Returns the converted value.  If a NULL screen, incorrect
  117.           _o_r_i_e_n_t_a_t_i_o_n, or incorrect _u_n_i_t__t_y_p_eis supplied as parameter
  118.           data, or if a parsing error occurred, 0 (zero) is returned.
  119.  
  120.      RRRREEEELLLLAAAATTTTEEEEDDDD
  121.           XXXXmmmmCCCCoooonnnnvvvveeeerrrrttttUUUUnnnniiiittttssss(3), XXXXmmmmSSSSeeeettttFFFFoooonnnnttttUUUUnnnniiiittttssss(3), and XXXXmmmmSSSSccccrrrreeeeeeeennnn(3).
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                           (printed 4/6/01)
  130.  
  131.  
  132.  
  133.